home *** CD-ROM | disk | FTP | other *** search
/ Netware Super Library / Netware Super Library.iso / editors / ted_asm / ted.hlp (.txt) < prev    next >
Encoding:
Borland Turbo Vision Help  |  1993-12-07  |  23.6 KB  |  538 lines

  1. FBHFV^
  2.  Turbo Editor  
  3.            *    WELCOME TO
  4.          **
  5.        ***        *******
  6.       ***           **    **** ****
  7.      ********       **    *     *  *
  8.      ********       **    ***   *  *
  9.          ***        **    *     *  *
  10.         ***         **    **** ****
  11.        **
  12.       * 
  13. TED has been designed to be a assembler IDE (Integrated Development Environment) which allows you to Edit/Compile/Link/Run/Debug/Profile your own assembler projects. We tried to make it as convinient as a C++ compiler like Borland C++. 
  14. See also: Index 
  15.  Index 
  16. Menu 
  17.           New
  18.           Open...
  19.           Save
  20.           Save
  21. as...
  22.           Save
  23.           Change
  24. dir...
  25.           DOS
  26. shell
  27.           Exit
  28. Alt-X
  29.           Screen
  30. 25/50
  31.           About
  32. Menu W
  33.           Undo
  34.           Cut
  35.           Copy
  36.           Paste
  37.           Clear
  38.           
  39. Search
  40. Menu 
  41.           Find
  42.           Replace
  43.           Search
  44. again
  45.           Goto
  46. Alt-G
  47.           Mark
  48. Postion
  49. Alt-<Number>
  50.           Go
  51. marked
  52. position
  53. Alt-J
  54. Compile
  55. Menu 
  56.           Compile
  57. Alt-F9
  58.           Make
  59.           Link
  60.           Run
  61.           Debug
  62.           Parameters
  63.           View
  64. Includes
  65. System
  66. Menu h
  67.           System|Window
  68. (open)
  69. Alt-0 
  70.           System|Window
  71. (closed)
  72. Ctrl-C                
  73. Miscellanous Screen: 
  74.           Project
  75.           OBJ
  76. Files
  77.           EXE
  78. Files
  79.           COM
  80. Files
  81.           Error
  82. Message
  83.           Message
  84. Window
  85.           Magic
  86.   Project 
  87. A project is a set of files needed to build an application. For example, your main program can be named VOCPLAY.ASM, and may need a VOCAPI.ASM, FILEAPI.ASM to compile. If so, you will create a project which will contain FIRST your main program (VOCPLAY.ASM), and then, in any order, the other files. When you will run a Compile|Make or a Compile|Run, all the files which have been modified since the last compilation will be recompiled, and all the OBJ files will be linked together to produce your executable. This is really helpful if you work with many source files. 
  88. You may want to convert your PJA (project) file to a MAK (make) file. To do so, use the Project|Convert project to Makefile command. TED will then produce a MAK file which has the same name than your PJA file in the current directory. 
  89. See also: Compile|Make
  90.           Compile|Run
  91.           Project|Convert
  92. project
  93. Makefile
  94.   OBJ File 
  95. An OBJ file is a file produced by a compiler (Assembler, C/C++, Pascal etc.). Those files are intermediate files, used to produce the EXE or the COM files with the help of the linker. They have a specific format that you can uncode using the following tables. #
  96. See also: Compile|Compile
  97. Alt-F9  1
  98.           Compile|Make
  99.           Compile|Link
  100.   EXE File 
  101. See also: Compile|Compile
  102. Alt-F9  1
  103.           Compile|Make
  104.           Compile|Link
  105.   COM File 
  106. See also: Compile|Compile
  107. Alt-F9  1
  108.           Compile|Make
  109.           Compile|Link
  110.   Error Message 
  111. An error message occurs each time you write something that either the compiler or the linker cannot understand. They ave all tracked, and display into the Message
  112. Window. You can jump to the line where the error has been detected by the compiler by simply pressing Enter on the designated error message. TED will then go to the source window at the right line. Correct the mistake, and use Window|Next
  113. F6 to came back to the message window. #
  114. See also: Compile|Compile
  115. Alt-F9  k
  116.           Compile|Make
  117.           Compile|Link
  118.           Compile|Run
  119.           
  120.           Message
  121. Window
  122.   Message Window 
  123. The message window is the window where TED display all the errors (and warnings) detected by the compiler/linker. This window is a normal window, that you can move, close, jump to etc. Use Enter to go to the line where the error has been detected by the compiler or the linker. #
  124. See also: Compile|Compile
  125. Alt-F9  i
  126.           Compile|Make
  127.           Compile|Link
  128.           Compile|Run
  129.           
  130.           ErrorMessage
  131.   Magic Key 
  132. Already need help ??? No, no, no... 6
  133. The magic key has something to do with information ! 
  134. Helpful, no ! 
  135.        TTTTTTTTT   EEEEEEEEE   DDDDDD            1111         000000000
  136.           TTT      EEE         DDD  DDD        111111         000   000
  137.           TTT      EEEEEE      DDD    DD          111         000   000
  138.           TTT      EEE         DDD  DDD           111   ...   000   000
  139.           TTT      EEEEEEEEE   DDDDDD             111   ...   000000000
  140.              
  141. The following persons have worked (some hard, some other no) to provide you TED, the Turbo Editor for Assembler: 8
  142.         Programmer   : Emmanuel THIOUX (Magic Manu ++)
  143.         Help System  : Fr
  144. ric THOMAS (FRED.ASM)
  145.         Online Doc.  : Fr
  146. ric THOMAS,
  147.                        Emmanuel THIOUX
  148.         QA           : Emmanuel THIOUX,
  149.                        Fr
  150. ric THOMAS
  151.         Beta Testers : Emmanuel THIOUX,
  152.                        Fr
  153. ric THOMAS,
  154.                        Xavier DUFAURE DE CITRES,
  155.                        Herv
  156.  AMBLARD,
  157.                        Glynne DAVIS
  158.         Original Idea: Emmanuel THIOUX
  159.         Improvements : Emmanuel THIOUX,
  160.                        Fr
  161. ric THOMAS
  162.                        
  163. This program has been written fully using Borland Pascal 7.0 (UI, File management etc.) and TASM 3.1 (XMS swapper, etc.). It cannot play VOC files, but if you ask for it... 
  164. If you think that this program is useful for you, don't forget to register your copy of TED. You'll get for free the next release of TED. To register, simply fill the REGISTER.IT file (once printed) and send it to: Z
  165.         Emmanuel THIOUX
  166.         8, rue Anatole France
  167.         60100 CREIL
  168.         FRANCE
  169. Thanks for your contribution. 
  170.          This program is a gift from Magic Manu++ to FRED.ASM.
  171.         The help system is a gift from FRED.ASM to Magic Manu++.
  172. This is just there for debugging purpose. With this, you can access any screen you want without going to the maze of the help system (reminds you something ?). 
  173. Dummy stuff: .
  174.           TED
  175. screen
  176.           TED
  177. Index
  178. Menu 
  179.           New
  180.           Open...
  181.           Save
  182.           Save
  183. as...
  184.           Save
  185.           Change
  186. dir...
  187.           DOS
  188. shell
  189.           Exit
  190. Alt-X
  191.           Screen
  192. 25/50
  193.           About
  194. Menu W
  195.           Undo
  196.           Cut
  197.           Copy
  198.           Paste
  199.           Clear
  200.           
  201. Search
  202. Menu 
  203.           Find
  204.           Replace
  205.           Search
  206. again
  207.           Goto
  208. Alt-G
  209.           Mark
  210. Postion
  211. Alt-<Number>
  212.           Go
  213. marked
  214. position
  215. Alt-J
  216. Compile
  217. Menu 
  218.           Compile
  219. Alt-F9
  220.           Make
  221.           Link
  222.           Run
  223.           Debug
  224.           Parameters
  225.           View
  226. Includes
  227. System
  228. Menu h
  229.           System|Window
  230. (open)
  231. Alt-0 
  232.           System|Window
  233. (closed)
  234. Ctrl-C                
  235. Miscellanous Screen: 
  236.           Project
  237.           OBJ
  238. Files
  239.           EXE
  240. Files
  241.           COM
  242. Files
  243.           Error
  244. Message
  245.           Message
  246. Window
  247.           Magic
  248.           
  249.   File 
  250. From here, you can do all the file related operations you may want to do. 
  251. See also: File|New 
  252.           File|Open...
  253.           File|Save
  254.           File|Save
  255. as...
  256.           File|Save
  257.           File|Change
  258. dir...
  259.           File|DOS
  260. shell
  261.           File|Exit
  262. Alt-X
  263.           File|Screen
  264. 25/50
  265.           File|About
  266.   File|New 
  267. This simply opens a new empty Untitled edit window. You can then type you source code in it, and save it using another name (File|Save as...). 
  268. See also: File|Open...
  269.           File|Save
  270.           File|Save
  271. as...
  272.           File|Save
  273.           
  274.           File|Change
  275. dir...
  276.   File|Open F3 
  277. This allows you to open a new existing (or not) file. If the file exists, it is loaded into TED, if not, an empty file is open, with the name you specify. Then you do not need to use the File:Save as... command; you can use directly the File|Save F2 command. 
  278. See also: File|New q
  279.           File|Save
  280.           File|Save
  281. as...
  282.           File|Save
  283.           
  284.           File|Change
  285. dir...
  286.   File|Save F2 
  287. This command just writes your current file to the disk. If the current file is untitled, the File|Save as... command is called so that you can name your creation. Use if often, you never know ! 
  288. See also: File|New I
  289.           File|Open
  290.           File|Save
  291. as...
  292.           File|Save
  293.           File|Change
  294. dir...
  295.           
  296.   File|Save as... 
  297. This command is used when the current file in TED is untitled. It allows you to name it before saving. If you forget to used it, and if you use File|Save instead, TED will ask your for a name before. 
  298. See also: File|New n
  299.           File|Open
  300.           File|Save
  301.           File|Save
  302.           
  303.           File|Change
  304. dir...
  305.   File|Save all 
  306. This command save ALL the files that are loaded in TED. If you don't know which files have not been saved, use this just to be sure. 
  307. See also: File|New p
  308.           File|Open
  309.           File|Save
  310.           File|Save
  311. as...
  312.           
  313.           File|Change
  314. dir...
  315.   File|Change dir... 
  316. This option allows you to change your working (current) directory. If you didn't change the default options, all the files will be taken from/written to this directory. All the commands like File|Open, File|Save, File|Save all etc. will be affected. 
  317. See also: File|Open
  318.           File|Save
  319.           File|Save
  320.   File|DOS shell 
  321. This command is helpful if you want to go temporaly to DOS to execute a COPY, a DEL or whatever. Be careful NOT to load TSR (Terminate and Stay Resident) programs from any DOS shell, otherwise TED (and other programs) will hang your computer when you will perform the EXIT. If you are not sure about a program,  don't run it or read its documentation first. Anyway, do NOT forget to save your work before performing a DOS shell. 
  322. See also: File|Exit
  323. Alt-X 
  324.   File|Exit Alt-X 
  325. When you have finished your session, use htis command to exit TED and return to the DOS prompt. The shortcut to exit is Alt-X. 
  326. See also: File|DOS
  327. Shell 
  328.   File|Screen mode 
  329.   File|About... 
  330. Using this command will show you the greetings of this program: R&D engineer, QA engineer, beta testers, etc. Find the magic key ! 
  331. See also: Magic
  332.   Edit 
  333. With this menu, you can cut, copy, paste etc. 
  334. See also: Edit|Undo Q
  335.           Edit|Cut
  336.           Edit|Copy
  337.           Edit|Paste
  338.           Edit|Clear
  339.   Edit|Undo 
  340. The Undo command allows you to "take back" the last editor action you performed.  For example, if the line: 
  341.   This is an editor test
  342. is changed to: 
  343.   This was an editor test
  344. The Undo command will become active.  Executing the Undo command will cause the line to revert back to its original version. Note that changes which can be undone are grouped into similar actions, such as typing, or deleting characters. Any action type you perform that is different than the last action type will cause the Undo information to be lost. 
  345. See also: Edit|Cut >
  346.           Edit|Copy
  347.           Edit|Paste
  348.           Edit|Clear
  349.   Edit|Cut Shift-Del 
  350. The Cut command removes the selected text and places it on the Clipboard. Any information previously on the clipboard is lost. Text cut from the editor may be immediately replaced by selecting the Edit|Undo command before moving the cursor. 
  351. See also: Edit|Undo >
  352.           Edit|Copy
  353.           Edit|Paste
  354.           Edit|Clear
  355.   Edit|Copy Ctrl-Ins 
  356. The Copy command places a copy of the selected text on the Clipboard. The selected information is left unchanged, but any information previously on the clipboard is lost. 
  357. See also: Edit|Undo =
  358.           Edit|Cut
  359.           Edit|Paste
  360.           Edit|Clear
  361.   Edit|Paste Shift-Ins 
  362. The Paste command inserts a the contents of the clipboard into the current editor window at the cursor position. The contents of the clipboard remain unchanged. If any text is selected in the current editor window, the highlighted text is replaced by the text coming from the clipboard. Information pasted into an editor may be removed immediately by using the Edit|Undo command before moving the cursor. 
  363. See also: Edit|Undo <
  364.           Edit|Cut
  365.           Edit|Copy
  366.           Edit|Clear
  367.   Edit|Clear Ctrl-Del 
  368. The Clear command removes any selected text from the current editor without placing a copy of the text on the clipboard. The effects of this command may be reversed by selecting Edit|Undo before moving the cursor. 
  369. See also: Edit|Undo <
  370.           Edit|Cut
  371.           Edit|Copy
  372.           Edit|Paste
  373.   Search 
  374. All the search/replace operations are accessible from this menu. 
  375. See also: Search|Find 
  376.           Search|Replace
  377.           Search|Search
  378. again
  379.           Search|Goto
  380. Alt-G
  381.           Search|Mark
  382. Postion
  383. Alt-<Number>
  384.           Search|Go
  385. marked
  386. position
  387. Alt-J
  388. (1..3)
  389.   Search|Find 
  390. If sometimes you have a huge source code, you may want to look quickly for a particular text or part of code. So, it's time to use the Search|Find command. Specify the text you are looking for in the edit field, and press enter. TED will locate the first occurence of the text you specified, and using Search again will go to the next occurence. After completing the edit field (Text to search you can check two options: 
  391.   o Case sensitive   : If you want a case sensitive search, check this button.
  392.   o Whole words only : If you want that TED search for whole words only (not in
  393.                        words themselves), check this button.
  394. See also: Search|Replace ?
  395.           Search|Search
  396. again
  397.           Search|Goto
  398. Alt-G
  399.   Search|Replace 
  400. If you have a variable or a label etc. that you want to change globally in all your source, the Replace command will be useful. After completing the two edit fields (Text to search/New text) you can check several options: 
  401.   o Case sensitive   : If you want a case sensitive search, check this button.
  402.   o Whole words only : If you want that TED search for whole words only (not in
  403.                        words themselves), check this button.
  404.   x Prompt on replace: If you want that TED doesn't ask you any confirmation on
  405.                        replace, uncheck this button.
  406.   o Replace all      : If you want TED to replace all occurence of you text,
  407.                        check this button.
  408. See also: Search|Find ?
  409.           Search|Search
  410. again
  411.           Search|Goto
  412. Alt-G
  413.   Search|SearchAgain 
  414. This command is useful to continue a search previous made by Search|Find or Search|Replace. 
  415. See also: Search|Find :
  416.           Search|Replace
  417.           Search|Goto
  418. Alt-G
  419.   Search|Goto line Alt-G 
  420. Sometimes, you may want to go to a certain line. Use the Search|Goto line or Alt-G, then fill the edit field with the line number you want to go to, and just press enter. TED will go to the line number you specified. 
  421. See also: Search|Find 7
  422.           Search|Replace
  423.           Search|Search
  424. again
  425.   Search|Mark Position <Num> Alt-<Num> 
  426. Sometimes, you may want to mark a the position of the current line in an edit  window and return to this position after. TED can store 3 marks by Edit Window. If you want to mark a position just strike alt + <number>. The number have to be in a range of 1..3. TED will shows you if you have some marks defined. You will could see them on  the bottom of the edit window. '
  427. See also: Go
  428. marked
  429. position
  430. Alt-J ,
  431.           Search|Goto
  432. Alt-G
  433.           
  434.   Search|Go to Mark Alt-J <Num> 
  435. If you have marked some location you can access to it whith Alt-J + <number  of the saved location>. Strike Alt-J then strike a key between 1 to 3. After that TED will go to the asked location. %
  436. See also: Mark
  437. Postion
  438. Alt-<Number> !
  439.           Search|Goto
  440. Alt-G
  441.   Compile 
  442. All the compile, link, run, etc. operations are accessible from this menu. "
  443. See also: Compile|Compile
  444. Alt-F9 
  445.           Compile|Make
  446.           Compile|Link
  447.           Compile|Run
  448.           Compile|Debug
  449.           Compile|Parameters
  450.           Compile|View
  451. Includes
  452.   Compile|Compile Alt-F9 
  453. TED has been designed to compile your assembler source code. It calls TASMX, catchs the results, and open a new window called the Message
  454. Window in which you can move from one Error
  455. Message to another. If you use Enter on an error message, TED will jump to the line number where the error occurs. Once your modification to this line made, you can use Window|Next
  456. F6 to go back to the message window. 
  457. If you want to set different options for the compilation than the one provided by default, open the Options|Compiler dialog, and modify any option you want. 
  458. See also: Compile|Make
  459. F9  k
  460.           Compile|Link
  461.           Compile|Run
  462.           Compile|Debug
  463.           
  464.           Options|Compiler
  465.   Compile|Make F9 
  466. If you have open a Project or if you have a standalone program, you can run the Compile|Make command. This will only compile the file needed (ie the ASM files which date are newer than the OBJ ones). This is obviously quicker than a Compile|Compile plus the Compile|Link options together. The other advantage is that TED won't forget any ASM file during the compilation. #
  467. See also: Compile|Compile
  468. Alt-F9  E
  469.           Compile|Link
  470.           Compile|Run
  471.           Compile|Debug
  472.   Compile|Link 
  473. Once you have used the Compile|Compile command, you have produced an OBJ file which should now be linked to give the EXE (or COM) corresponding file. To do so, you have to use the Compile|Link command. Like for the Compile|Compile menu, TED will open an Error
  474. Message window which will display you all the errors encountered during the link process. 
  475. If you want to set different options for the link than the one provided by default, open the Options|Linker dialog, and modify any option you want. #
  476. See also: Compile|Compile
  477. Alt-F9  i
  478.           Compile|Make
  479.           Compile|Run
  480.           Compile|Debug
  481.           
  482.           Options|Linker
  483.  Compile|Run 
  484. Once you EXE (or your COM) program has been created, you may want to run it from the IDE. To do so, use the Compile|Run command. At this point, TED swap his own code to XMS (or disk if XMS is not available) to make room enough for your program to be executed. N
  485. If your program needs parameters to run, use the Compile|Parameters command. 
  486.      < WARNING >
  487.      
  488. Do **NOT** run TSR (Terminate and Stay Resident) program directly from TED, otherwise your computer will surely hang, and you work may be lost. Be really careful with those kind of programs. We advice you to EXIT TED before running a TSR, and to be sure that you are under the first shell of DOS. #
  489. See also: Compile|Compile
  490. Alt-F9  F
  491.           Compile|Make
  492.           Compile|Link
  493.           Compile|Debug
  494.           Compile|Parameters
  495.  Compile|Debug 
  496. If your program does not work exactly as you expect it to work after the first error free compilation, you may want to use a debugger to see what is going on. To do so, use the Compile|Debug command. This will run the debugger from the IDE, with your program loaded in it. You should have compiled it successfully at least once. N
  497. If your program needs parameters to run, use the Compile|Parameters command. #
  498. See also: Compile|Compile
  499. Alt-F9  D
  500.           Compile|Make
  501.           Compile|Link
  502.           Compile|Run
  503.           Compile|Parameters
  504.  Compile|Parameters 
  505. If your program needs some parameters to run properly, you can specify them in the Compile|Parameters edit field. They will be now used each time you will run your program from the IDE until you exit TED. The command line parameters are limited to approximatively 80 caracters. #
  506. See also: Compile|Compile
  507. Alt-F9  \
  508.           Compile|Make
  509.           Compile|Link
  510.           Compile|Run
  511.           Compile|Debug
  512.  Compile|View Includes 
  513. If your program contains include files (i.e include misc.inc or TWindow.aso  etc...)  you can access, view and edit them with this function. TED will shows you a dialog box with the list of the currents include files. Just select one then click Ok. the file will be loaded from disk and you will be able to edit and modify it. ,
  514. See also: System|Window
  515. (Open)
  516. Alt-0  ,
  517.           System|Window
  518. (Close)
  519. Ctrl-C
  520.  System (
  521. Some miscellaneous options are accessibles from this menu, like system  informations, Calculator, Ascii table, etc... ,
  522. See also: System|Window
  523. (open)
  524. Alt-0  ,
  525.           System|Window
  526. (Close)
  527. Ctrl-C
  528.  System|Window List (Open) Alt-0 
  529. A dialog box displays the list of open windows. If you want to access to one of them, just select is name then click Ok. TED will put the designed window on the top. -
  530. See also: System|Window
  531. (Close)
  532. Ctrl-C 
  533.  System|Window List (Close) Ctrl-C 
  534. A dialog box displays the list of closed windows. If you want to access to one of them, just select is name then click Ok. TED will load the designed file then put it on the top of window list. +
  535. See also: System|Window
  536. (Open)
  537. Alt-0 
  538.